Update the design document #108
Conversation
clalancette
force-pushed
the
clalancette/design-document
branch
from
156f18a to
7eb196d
Compare
There was a problem hiding this comment.
Thanks for taking the time to document all this valuable information! Left some feedback comments (happy to push changes directly if you're ok too). In addition, I think we should delete this section from the readme since it is expanded upon here.
|
|
||
| As of 2024-02-09, the user is expected to launch the router by hand. | ||
| In the future, additional work may be done to automatically launch a Zenoh router if one isn't already running. | ||
|
|
There was a problem hiding this comment.
Should we mentioned a couple lines about the default router config and how it is configured to disable multicast scouting and enables gossip scouting instead?
There was a problem hiding this comment.
As a follow up, should we include a section on the session config?
There was a problem hiding this comment.
I'm going to go ahead and add a section for both of these.
While looking at this, I realized that our environment variables are named ZENOH_ROUTER_CONFIG_URI and ZENOH_SESSION_CONFIG_URI. But we don't treat them as URIs, we treat them as filenames. Should we change that somehow?
Signed-off-by: Chris Lalancette <[email protected]>
Signed-off-by: Chris Lalancette <[email protected]>
Co-authored-by: Yadu <[email protected]> Signed-off-by: Chris Lalancette <[email protected]>
Signed-off-by: Chris Lalancette <[email protected]>
Signed-off-by: Chris Lalancette <[email protected]>
clalancette
force-pushed
the
clalancette/design-document
branch
from
95ee937 to
051c630
Compare
|
@Yadunund I've responded to most of your feedback now. There are a couple of pieces of information that I don't have, so I didn't update those. If you can take another look, that would be appreciated. |
This PR does a large rewrite of the design document, adding in a lot more detail about how rmw_zenoh_cpp conforms to the RMW interface.
I'll note that this document isn't complete; in particular, the section on how Events works is incomplete (until we get #103 in), and the section on Security is completely empty. Nevertheless, I think it expand quite a bit on what we currently have and will give users some idea on the choices we made and why.